Saltar para o conteúdo principal
PATCH
/
public
/
v1
/
toppie
/
campaigns
/
{campaign-id}
[BETA] Update Toppie Campaign
curl --request PATCH \
  --url https://api.topsort.com/public/v1/toppie/campaigns/{campaign-id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "budget": 10000000000,
  "targets": {
    "add": [
      "<string>"
    ],
    "remove": [
      "<string>"
    ]
  },
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "targetRoas": 123,
  "isActive": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "adFormat": "banner",
  "chargeType": "CPM",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "budget": 123,
  "budgetPeriod": "daily",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "targetRoas": 10.25,
  "currencyCode": "<string>",
  "isActive": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "bidCount": 123
}

Autorizações

​
Authorization
string
header
obrigatório

A valid API key generated in Topsort's UI.

Parâmetros de caminho

​
campaign-id
string<uuid>
obrigatório

The ID of the campaign.

Corpo

application/json

Agency campaign fields to be updated

​
name
string | null

Campaign name, this will be propagated to campaigns in marketplaces

Required string length: 1 - 75
​
budget
integer | null

Total budget for this campaign, to be distributed across marketplaces

Intervalo necessário: 0 < x < 20000000000
​
targets
PublicUpdateTargets · object

Targets to be included or removed from the campaign

​
startDate
string<date-time> | null

Date when to start the campaign, specified in RFC 3339, if not set that campaign will start immediately after the campaign creation. Must include the Timezone definition.

​
endDate
string<date-time> | null

Date when to stop the campaign, specified in RFC 3339, if not set the campaign will never stop. This date must be greater than the start date and must be in the future. Must include the Timezone definition.

​
targetRoas
number | null

Target ROAS for the campaign

​
isActive
boolean | null

Flag to indicate if the campaign is active or not

Resposta

Successful Response

Represents a public version of an agency campaign, used in API responses.

​
id
string<uuid>
obrigatório

Internal identifier for the agency campaign

​
name
string
obrigatório

Campaign name

​
adFormat
enum<string>
obrigatório

The ad format for this campaign

Opções disponíveis:
banner,
listing
​
chargeType
enum<string>
obrigatório

The charge type for this campaign

Opções disponíveis:
CPM,
CPC,
CPA
​
accountId
string<uuid>
obrigatório

Account that owns this campaign

​
budget
integer
obrigatório

Total budget for this campaign

​
budgetPeriod
enum<string>
obrigatório

The periodicity of the budget

Opções disponíveis:
daily,
weekly,
monthly,
total
​
startDate
string<date-time>
obrigatório

Date when the campaign starts, specified in RFC 3339. Must include the Timezone definition.

​
endDate
string<date-time>
obrigatório

Date when the campaign ends, specified in RFC 3339. Must include the Timezone definition.

​
targetRoas
number
obrigatório

Target ROAS for the campaign

Intervalo necessário: 0.5 <= x <= 20
​
currencyCode
string
obrigatório

Currency code this campaign is working with in ISO 4217 format

Exemplo:

"USD"

​
isActive
boolean
obrigatório

Flag to indicate if the campaign is active or not

​
createdAt
string<date-time>
obrigatório

Date and time when the campaign was created

​
bidCount
integer | null

Bid count for the campaign (optional)